Skip to content

Update the release process to leverage GitHub Actions #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
clintval wants to merge 11 commits into from
Closed

Update the release process to leverage GitHub Actions #37

clintval wants to merge 11 commits into from

Conversation

@clintval
Copy link
Member

@clintval clintval commented Aug 8, 2024 •
edited
Loading

Dependent on:

  • Making GitHub a trusted PyPi publisher for this package: https://docs.pypi.org/trusted-publishers/adding-a-publisher/
  • Allowing the use of conventional commits: https://www.conventionalcommits.org/en/v1.0.0/
    • If conventional commits are not used, this workflow still does the right thing!
  • Updating the release process: https://github.com/fulcrumgenomics/pybedlite/wiki/Performing-a-Release
    • Move the process out of GitHub wiki and into CONTRIBUTING.md so it is easier to find
    • Process minimizes to:
      1. Manually and locally, bump the package version in the pyproject.toml to your desired SemVer
      2. Open a local branch, commit version bump changes, and then push to a remote branch
      3. Open a PR for your branch with a Git commit message like chore(release): bump to X.X.X
      4. Squash merge the PR
      5. Tag the new commit on main with the same SemVer, triggering a publish to PyPi and GitHub:
        • Source distribution
        • Binary distributions for all Python versions and architectures

The publish workflow looks like:

Screenshot 2024-08-08 at 9 07 41 AM

@clintval clintval temporarily deployed to github-action-ci August 8, 2024 16:20 — with GitHub Actions Inactive
@clintval clintval temporarily deployed to github-action-ci August 8, 2024 16:20 — with GitHub Actions Inactive
@clintval clintval temporarily deployed to github-action-ci August 8, 2024 16:20 — with GitHub Actions Inactive
@clintval clintval temporarily deployed to github-action-ci August 8, 2024 16:20 — with GitHub Actions Inactive
@clintval clintval temporarily deployed to github-action-ci August 8, 2024 16:20 — with GitHub Actions Inactive
@clintval clintval temporarily deployed to github-action-ci August 8, 2024 16:20 — with GitHub Actions Inactive
@clintval clintval temporarily deployed to github-action-ci August 8, 2024 16:20 — with GitHub Actions Inactive
@clintval clintval temporarily deployed to github-action-ci August 8, 2024 16:20 — with GitHub Actions Inactive
@clintval clintval requested review from jdidion, nh13 and tfenne August 8, 2024 16:23
nh13
nh13 requested changes Aug 8, 2024
View reviewed changes
Copy link
Member

@nh13 nh13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few Qs, and we'll need to set up a few things before merge

clintval
clintval commented Aug 8, 2024
View reviewed changes
@clintval clintval requested a review from nh13 August 8, 2024 16:45
nh13
nh13 approved these changes Aug 8, 2024
View reviewed changes
Copy link
Member

@nh13 nh13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@codecov
Copy link

codecov bot commented Aug 8, 2024 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.25%. Comparing base (b01175e) to head (b949f6d).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main      #37   +/-   ##
=======================================
  Coverage   95.25%   95.25%           
=======================================
  Files           8        8           
  Lines         674      674           
  Branches      119      119           
=======================================
  Hits          642      642           
  Misses         18       18           
  Partials       14       14

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@clintval
Copy link
Member Author

clintval commented Aug 8, 2024 •
edited
Loading

@nh13 I might need some help allowing GitHub to be a PyPi publisher. Although I have access to release new versions of pybedlite on PyPi, I don't have authorization to manage the project:

Screenshot 2024-08-08 at 1 20 06 PM

Could you navigate to here and add a GitHub publisher with the following values?

  • Owner: fulcrumgenomics
  • Repository name: pybedlite
  • Workflow name: publish.yml
  • Environment name: pypi

@nh13
Copy link
Member

nh13 commented Aug 8, 2024

Done, for pybedlite (not bedspec as per your link :P)

@clintval
Copy link
Member Author

clintval commented Aug 8, 2024

Done, for pybedlite (not bedspec as per your link :P)

Ah! My playground for ideas :)

@clintval clintval marked this pull request as ready for review August 8, 2024 22:25
nh13
nh13 reviewed Aug 16, 2024
View reviewed changes
.github/workflows/wheels.yml
- uses: actions/setup-python@v4
- uses: actions/setup-python@v5
with:
python-version: 3.8
Copy link
Member

@nh13 nh13 Aug 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be ${{ matrix.python }}?

Copy link
Member Author

@clintval clintval Aug 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, you really do just need a single and separate Python for building the wheels. It's OK to use 3.8 here. I think I've tried bumping it up, but you'll hit compatibility issues with cibuidwheel and a few of the other configuration in the GitHub action. At some point I'll get this up to 3.12 and fixup the rest too. You're welcome to try swapping 3.8 for 3.12 (or something else newer) here and chasing down any errors/warnings with cibuildwheel.

@clintval clintval mentioned this pull request Sep 18, 2024
Closed
@clintval clintval mentioned this pull request Dec 2, 2024
Merged
@clintval clintval mentioned this pull request Mar 19, 2025
Merged
@clintval
Copy link
Member Author

clintval commented Sep 18, 2025

Closing because this is stale now. Will revive this project after the superintervals PR is merged (significantly cleaning up the build process) and I will borrow the GitHub Actions from the Python template too, to save time.

@clintval clintval closed this Sep 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nh13 nh13 nh13 approved these changes

@jdidion jdidion Awaiting requested review from jdidion

@tfenne tfenne Awaiting requested review from tfenne tfenne is a code owner

Assignees

@jdidion jdidion

@nh13 nh13

@tfenne tfenne

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@clintval @nh13 @jdidion @tfenne